<?php

/**
 * Field handler to provide simple renderer that allows linking to a taxonomy
 * term.
 */
class views_handler_field_taxonomy extends views_handler_field {

    /**
     * Constructor to provide additional field to add.
     *
     * This constructer assumes the term_data table. If using another
     * table, we'll need to be more specific.
     */
    function construct() {
        parent::construct();
        $this->additional_fields['vid'] = 'vid';
        $this->additional_fields['tid'] = 'tid';
    }

    function option_definition() {
        $options = parent::option_definition();
        $options['link_to_taxonomy'] = array('default' => FALSE);
        return $options;
    }

    /**
     * Provide link to taxonomy option
     */
    function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $form['link_to_taxonomy'] = array(
            '#title' => t('Link this field to its taxonomy term page'),
            '#description' => t('This will override any other link you have set.'),
            '#type' => 'checkbox',
            '#default_value' => !empty($this->options['link_to_taxonomy']),
        );
    }

    /**
     * Render whatever the data is as a link to the taxonomy.
     *
     * Data should be made XSS safe prior to calling this function.
     */
    function render_link($data, $values) {
        if (!empty($this->options['link_to_taxonomy']) && !empty($values->{$this->aliases['tid']}) && $data !== NULL && $data !== '') {
            $term = new stdClass();
            $term->tid = $values->{$this->aliases['tid']};
            $term->vid = $values->{$this->aliases['vid']};
            $this->options['alter']['make_link'] = TRUE;
            $this->options['alter']['path'] = taxonomy_term_path($term);
        }
        return $data;
    }

    function render($values) {
        return $this->render_link(check_plain($values->{$this->field_alias}), $values);
    }

}
